home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / lcdty102.zip / LUCIDITY.DOC next >
Text File  |  1991-08-18  |  17KB  |  478 lines
  1.         
  2.         
  3.         
  4.         
  5.         
  6.         
  7.         
  8.         
  9.         
  10.         
  11.                                  Lucidity V1.02
  12.         
  13.         
  14.         
  15.         
  16.         
  17.         
  18.                                Copyright (c) 1991
  19.         
  20.                                 By Greg Spurrier
  21.         
  22.         
  23.         
  24.         
  25.         
  26.                         Version released August 17, 1991
  27.         
  28.         
  29.         
  30.         
  31.         
  32.         
  33.         
  34.         
  35.         
  36.         
  37.         
  38.         
  39.         
  40. Overview
  41. ========
  42.         
  43.         Webster's New World Dictionary defines lucidity as, among other 
  44.         things, "...clear to the mind; readily understood...."  That is 
  45.         the purpose of this program--to take a Remote Access log file and 
  46.         extract from it the pertinent information and present it in a 
  47.         manner that is clear to the mind and readily understood.
  48.         
  49.         Lucidity searches through the RA.LOG file to find the information 
  50.         which the user desires, and displays it without all of the other 
  51.         extraneous information often found in a log file.  Lucidity 
  52.         searches the log file for the information which Sysops must 
  53.         normally wade through a cluttered log file and pick out by hand.  
  54.         Among the capabilities of Lucidity are the ability to show the 
  55.         names, dates, and times of all log-ins in the log file, all file 
  56.         transfers, all users who have dropped the carrier or allowed the 
  57.         inactivity timer to expire.
  58.         
  59.         Lucidity presents all of this information in a concise, easy to 
  60.         read format that allows the system operator to spend his or her 
  61.         time concentrating on the information in the log file, rather 
  62.         than trying to find it.
  63.         
  64.         Lucidity is extremely self explanatory so, the manual may seem a 
  65.         little short, but all that is necessary is included.  The author 
  66.         believes that it is better to spend a lot of time developing and 
  67.  
  68.         testing an easy to use program than to spend a lot of time writ-
  69.         ing documentation for a difficult to use program.
  70.         
  71.         
  72.         
  73.         
  74. Registration
  75. ============
  76.         
  77.         Lucidity is distributed under the shareware concept of trying out 
  78.         software before you purchase it.  You are free to evaluate this 
  79.         program for a period of two weeks.  If you find Lucidity useful 
  80.         continue to use it, you are obligated to register with the author 
  81.         by sending a registration fee of $10 along with the following 
  82.         registration form.  If you decide that Lucidity is not a useful 
  83.         addition to your software library, and decide not to register, 
  84.         you must remove all copies of the program (other than the 
  85.         LCDTY102.ZIP file, which you may keep available for uploading to
  86.         other systems, or downloading to your users) from your system.
  87.         
  88.         Once your registration form and payment have been received, you 
  89.         will be sent a unique key which will allow you to access the 
  90.         registered user only options (explained later in this document).
  91.         
  92.         Registration also entitles you to announcements of upgrades and 
  93.         new products by its author, Greg Spurrier, and will help finance 
  94.         the development of new versions of Lucidity and also new programs 
  95.         for your enjoyment.
  96.         
  97.         
  98.         
  99.         
  100.         -----------------------------------------------------------------
  101.         
  102.         
  103.                                 REGISTRATION FORM   
  104.         
  105.         
  106.         
  107.         Name ____________________________________________________
  108.         
  109.         
  110.         
  111.         Address _________________________________________________
  112.         
  113.         
  114.                 _________________________________________________
  115.         
  116.                
  117.                 _________________________________________________
  118.          
  119.         
  120.         Voice Telephone # (___)____________
  121.         
  122.         
  123.         BBS Name ________________________________________________
  124.         
  125.         
  126.         BBS Fidonet address _____________________________________
  127.         
  128.         
  129.         BBS Telephone # (___)____________
  130.         
  131.         
  132.         Version number of Lucidity _______
  133.         
  134.  
  135.         
  136.         How did you get your copy of Lucidity? __________________
  137.         
  138.         
  139.         _________________________________________________________
  140.         
  141.         
  142.         
  143.         Comments / Suggestions __________________________________
  144.         
  145.         
  146.         _________________________________________________________
  147.         
  148.         
  149.         _________________________________________________________
  150.         
  151.         
  152.         _________________________________________________________
  153.         
  154.         
  155.         Please mail this form along with check or money order, payable to 
  156.         Greg Spurrier, for $10 (or $15 for the latest version of Lucidity 
  157.         on disk) to:
  158.         
  159.                   Greg Spurrier
  160.                   5711 S. Indianapolis
  161.                   Tulsa, OK  74135
  162.         
  163.         
  164.         
  165.         -----------------------------------------------------------------
  166.         
  167.         
  168.         You are free to distribute Lucidity to your friends or to upload it 
  169.         to a BBS provide that:  1) no fee is charged for this software 
  170.         (excluding disk duplication fees and online charges if distribut-
  171.         ed over a BBS), 2) Lucidity is distributed in its original, unmodi-
  172.         fied form, and 3) all supporting files, including this file, are 
  173.         distributed along with Lucidity.
  174.         
  175.         
  176.         
  177.         
  178. Disclaimer
  179. ==========
  180.         
  181.         In no event will Greg Spurrier, the author of Lucidity, be liable 
  182.         for any damages which occur from the use or misuse of this pro-
  183.         gram.
  184.         
  185.         
  186.         
  187.         
  188. Installation
  189. ============
  190.         
  191.         It is recommended that LUCIDITY.EXE be placed in the same direc-
  192.         tory as the RA.LOG file.  When Lucidity is run, it searches for 
  193.         the RA.LOG file in the directory from which it is run and also in 
  194.         the \RA directory.  If the log file is not found, the user will 
  195.         be prompted to enter the path in which RA.LOG is located.  Press-
  196.         ing [ENTER] without typing a path, will cause Lucidity to exit 
  197.         back to DOS.
  198.         
  199.         
  200.         
  201.  
  202.         
  203. Main Menu
  204. =========
  205.         
  206.         The main menu lists all of the available Lucidity functions, as 
  207.         well as the name, BBS name, and registration date of a registered 
  208.         user.  If the user is a registered user, a status box which 
  209.         indicates the output device for the lists is displayed (non 
  210.         registered users are limited to viewing the lists on their moni-
  211.         tors).
  212.         
  213.         
  214.         To select a menu item, simply type the first letter of the func-
  215.         tion.  For example:  To select the 'New users' function, type 'N' 
  216.         or 'n'.
  217.         
  218.         
  219.         
  220. Functions
  221. =========
  222.         
  223.         User Logins
  224.         -----------
  225.         
  226.         The User logins lists all the log-ins of a particular person in 
  227.         the log file.
  228.         
  229.         After typing 'U', the program will prompt for a user name.  The 
  230.         user name can be an entire name, or part of a name.  Capitaliza-
  231.         tion does not matter.
  232.         
  233.         Greg Spurrier    |
  234.         greg spurrier    |--- All of these will work identically
  235.         GREG SPURRIER    |
  236.         
  237.         Greg             |--- Find all occurrences of 'Greg' in log
  238.         
  239.         Spurrier         |--- Find all occurrences of 'Spurrier' in log
  240.         
  241.         Below the name prompt, are listed the two options which can be 
  242.         entered instead of a name.  'All' will list all names; 'Quit' 
  243.         will exit back to the Main Menu.
  244.         
  245.         If 'All' is entered as the name, the user will be prompted about 
  246.         including local log-ins in the list.  The default is not to in-
  247.         clude local log-ins in the list of users.  This way, the listing 
  248.         is not cluttered with Sysop logins.  In order to see all logins, 
  249.         including local ones, type 'Y' at this prompt.
  250.         
  251.         
  252.         File Transfers
  253.         --------------
  254.         
  255.         The File transfers lists file transfers in the log file.
  256.         
  257.         After selecting the File transfers function from the menu, the 
  258.         user is prompted to choose to search by File (default) or User.  
  259.         To show all transfers of a particular file, choose FILE.  To show 
  260.         all file transfers made by a particular user, choose User.
  261.         
  262.         After selecting search type, the user is prompted for File (or 
  263.         User) name.  The workings of this prompt are identical to the 
  264.         User name prompt in the User logins function.
  265.         
  266.         Do not use wildcards when entering a File name.
  267.         
  268.  
  269.         NOTE:  This function works with the built in Remote Access file 
  270.         transfer system.  Because of variances in log entries, the func-
  271.         tion may not work if an external file transfer program is used.  
  272.         If you use an external file transfer program, go ahead and try 
  273.         this function, but don't be surprised if it does not work cor-
  274.         rectly.
  275.         
  276.         
  277.         Time Limit Exceeded
  278.         -------------------
  279.         
  280.         The Time limit exceeded function displays all users who have been 
  281.         disconnected because they have used all of their time for the 
  282.         day.
  283.         
  284.         This is a simple one--Just press 'T' and watch....
  285.         
  286.         
  287.         Password Tries Exceeded
  288.         -----------------------
  289.         
  290.         The Password tries exceeded function displays all users who have 
  291.         been disconnected because they were not able to supply the cor-
  292.         rect password within the number of tries that are allowed.
  293.         
  294.         This is another simple one....
  295.         
  296.         
  297.         Dropped Carriers
  298.         ----------------
  299.         
  300.         The Dropped carriers function lists displays all users who have 
  301.         dropped the carrier instead of logging off normally.
  302.         
  303.         Yep, it's another simple one....
  304.         
  305.         
  306.         Inactivity Timer Expires
  307.         ------------------------
  308.         
  309.         Yet another simple one....
  310.         
  311.         This lists the people who were disconnected because the inactivi-
  312.         ty timer expired.
  313.         
  314.         
  315.         Serious Offenders
  316.         -----------------
  317.         
  318.         When this function is selected, it will prompt for the minimum 
  319.         number of offenses.  This number will be the number of offenses 
  320.         that a user must have committed before showing up on the Serious 
  321.         offender list.  2 or 3 is a good minimum to start with.
  322.         
  323.         Offenses that count are the four that are listed above--Time 
  324.         limit exceeded, Password tries exceeded, Dropped carriers, and 
  325.         Inactivity time expires.
  326.         
  327.         This one can be quite useful in pin pointing problem users who 
  328.         may need a reminder note of BBS etiquette.
  329.         
  330.         
  331.         New Users
  332.         ---------
  333.         
  334.         You guessed it, it lists the new users.
  335.  
  336.         
  337.         
  338.         Output device toggle (Registered users only)
  339.         --------------------
  340.         
  341.         This switches between output to screen, printer, or to disk.  The 
  342.         current output device (if the user has registered) is displayed 
  343.         in the box directly above the user registration information box.  
  344.         If disk is selected, the output will be put in a file called 
  345.         SUMMARY.MEN, and will be in the current directory.
  346.         
  347.         
  348.         Quit
  349.         ----
  350.         
  351.         Quit, enough said....
  352.         
  353.         
  354.         
  355. Unattended Running (Registered users only)
  356. ==================
  357.         
  358.         If Lucidity is registered, the user has an option to run Lucidity 
  359.         in unattended mode (this way it can be run as part of your system 
  360.         event and the output will be sent to a file called SUMMARY.LUC 
  361.         or, if you choose, the printer).
  362.         
  363.         To access the Unattended running mode, Lucidity must be run with 
  364.         one or more of the following command line switches:
  365.         
  366.         PRINTER  Send output to Printer instead of SUMMARY.LUC.  Note 
  367.                that it MUST be the first switch following LUCIDITY.  Also
  368.                please read cautions about using the printer!
  369.         
  370.         -U     Prints a list of all log-ins (excluding local log-ins)
  371.                 
  372.         -F     Prints all file transfers in the log 
  373.         
  374.         -T     Prints all users whose time limit expired while online
  375.         
  376.         -P     Prints all users who could not furnish their password
  377.         
  378.         -D     Prints all users who dropped the carrier
  379.         
  380.         -I     Prints all users who allowed the inactivity timer to 
  381.                expire
  382.         
  383.         -N     Prints all new users
  384.         
  385.         -Sn    Prints all serious offenders with a minimum of n offenses
  386.                If n is not supplied, Lucidity defaults to 2
  387.         
  388.         The unattended mode works best when used in conjunction with a 
  389.         utility that nightly copies the log and resets the current log.  
  390.         Lucidity should be run in the unattended mode just before this 
  391.         utility is run.
  392.         
  393.         If you do not have such a utility, a batch file similar to the 
  394.         following can be used to run Lucidity in the unattended mode and 
  395.         then move your RA.LOG file to another directory so that it can 
  396.         still be viewed during the following day.
  397.         
  398.         LUCIDITY.BAT
  399.         
  400.         CD \RA\LOGS                        
  401.         REM   or wherever LUCIDITY.EXE and RA.LOG are located
  402.  
  403.         LUCIDITY -U -F -T -P -D -I -N -S3
  404.         REM   run Lucidity in unattended mode with all options, and 3 as 
  405.         REM   the minimum number of offenses for Serious Offenders.
  406.         COPY RA.LOG \RA\BAKLOG
  407.         REM   or wherever you wish to store the old log
  408.         DEL RA.LOG
  409.         
  410.         
  411.         NOTE:  If a SUMMARY.LUC file already exists, Lucidity will add 
  412.         the new information to the end of the file.
  413.         
  414.         PRINTER CAUTIONS:  Be sure that the printer is on and on-line 
  415.         before running the system event.  If the printer is off, or out 
  416.         of paper, Lucidity will detect this when it starts (but be sure 
  417.         that it has enough paper to print its information, as it does not 
  418.         check again after it starts) and exit to DOS.  If it is on, but 
  419.         offline, the program will wait until it is online to continue, 
  420.         thus locking up the system (Sorry, I tried, but I couldn't get it 
  421.         to recognize an offline printer.  If anyone knows how to do this 
  422.         in C, please, please, tell me).
  423.         
  424.         It is recommended that you first let Lucidity create SUMMARY.LUC 
  425.         and then print it out later.  But, if you insist on printing at 
  426.         system event time, Lucidity will do that too....
  427.         
  428.         
  429. Registration Key
  430. ================
  431.         
  432.         Once your registration payment is received, you will be sent a 
  433.         unique registration key.  You may not give this key to anyone 
  434.         else, it is not shareware.  
  435.         
  436.         All that needs to be done for the key to work is to copy it into 
  437.         the directory that Lucidity is in (make sure that you always run 
  438.         Lucidity from that directory, otherwise, the key may not be 
  439.         found).  Simple, huh?
  440.         
  441.         
  442.         
  443.         
  444. Special Thanks
  445. ==============
  446.         
  447.         Special thanks to Chris Prater for being my BETA tester of Lucid-
  448.         ity from its very beginning.  Without his testing, and suggest-
  449.         ing, and testing some more, Lucidity would never be the powerful 
  450.         utility that it is today.
  451.         
  452.         
  453.         Thanks also to Tim Winters for his suggestions and testing Lucid-
  454.         ity on RemoteAccess Version .04a using an unusually cluttered
  455.         logfile from more than just RemoteAccess.
  456.         
  457.         
  458.         
  459. That's All
  460. ==========
  461.         
  462.         Well, that's about it.  I hope you find Lucidity to be as useful 
  463.         to you as it has been to me and my BETA tester.  If you have any 
  464.         suggestions, comments, or (gasp) bugs to report, please send them 
  465.         to me at the address listed on the registration form.
  466.         
  467.         Thank you and happy computing...
  468.         
  469.  
  470.           ()  ,
  471.           /`-'|
  472.          /   / __  _  _,
  473.         /__-<_/ (_</_(_)_
  474.                       /|
  475.                      |/
  476.          
  477.         
  478.